Node / meshtastic / Meshtastic-Android / files / .github / workflows / docs.yml

Displaying Raw • Download

T8b949e# This workflow builds and deploys the Dokka documentation to GitHub Pages.

Tff7b72nameTb4b4b4: Ta5d6ffDeployTa5d6ff Ta5d6ffDocumentation

Tff7b72onTb4b4b4:

Tff7b72pushTb4b4b4:

Tff7b72branchesTb4b4b4:

Tb4b4b4- Ta5d6ffmain

Tff7b72pathsTb4b4b4:

T8b949e# Only rebuild docs when source code changes (Dokka generates from KDoc)

Tb4b4b4- Ta5d6ff'Ta5d6ffapp/src/**Ta5d6ff'

Tb4b4b4- Ta5d6ff'Ta5d6ffcore/**/src/**Ta5d6ff'

Tb4b4b4- Ta5d6ff'Ta5d6fffeature/**/src/**Ta5d6ff'

Tb4b4b4- Ta5d6ff'Ta5d6ffdesktop/src/**Ta5d6ff'

Tb4b4b4- Ta5d6ff'Ta5d6ffbuild-logic/**Ta5d6ff'

Tb4b4b4- Ta5d6ff'Ta5d6ffbuild.gradle.ktsTa5d6ff'

Tb4b4b4- Ta5d6ff'Ta5d6ffsettings.gradle.ktsTa5d6ff'

Tb4b4b4- Ta5d6ff'Ta5d6ff.github/workflows/docs.ymlTa5d6ff'

T8b949e# Allows you to run this workflow manually from the Actions tab

Tff7b72workflow_dispatchTb4b4b4:

Tff7b72inputsTb4b4b4:

Tff7b72refTb4b4b4:

Tff7b72descriptionTb4b4b4: Ta5d6ff'Ta5d6ffTheTe6edf3 Ta5d6ffbranch,Te6edf3 Ta5d6fftagTe6edf3 Ta5d6fforTe6edf3 Ta5d6ffSHATe6edf3 Ta5d6fftoTe6edf3 Ta5d6ffcheckoutTa5d6ff'

Tff7b72requiredTb4b4b4: Ta5d6fffalse

Tff7b72typeTb4b4b4: Ta5d6ffstring

T8b949e# Allow this workflow to be called from other workflows

Tff7b72workflow_callTb4b4b4:

Tff7b72inputsTb4b4b4:

Tff7b72refTb4b4b4:

Tff7b72descriptionTb4b4b4: Ta5d6ff'Ta5d6ffTheTe6edf3 Ta5d6ffbranch,Te6edf3 Ta5d6fftagTe6edf3 Ta5d6fforTe6edf3 Ta5d6ffSHATe6edf3 Ta5d6fftoTe6edf3 Ta5d6ffcheckoutTa5d6ff'

Tff7b72requiredTb4b4b4: Ta5d6fffalse

Tff7b72typeTb4b4b4: Ta5d6ffstring

T8b949e# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages

Tff7b72permissionsTb4b4b4:

Tff7b72contentsTb4b4b4: Ta5d6ffread

Tff7b72pagesTb4b4b4: Ta5d6ffwrite

Tff7b72id-tokenTb4b4b4: Ta5d6ffwrite

T8b949e# Allow only one concurrent deployment; cancel queued runs since only the latest

T8b949e# main state matters for documentation.

Tff7b72concurrencyTb4b4b4:

Tff7b72groupTb4b4b4: Ta5d6ff"Ta5d6ffpagesTa5d6ff"

Tff7b72cancel-in-progressTb4b4b4: Ta5d6fftrue

Tff7b72jobsTb4b4b4:

Tff7b72build-docsTb4b4b4:

Tff7b72ifTb4b4b4: Ta5d6ffgithub.repositoryTa5d6ff Ta5d6ff==Ta5d6ff Ta5d6ff'meshtastic/Meshtastic-Android'

Tff7b72runs-onTb4b4b4: Ta5d6ffubuntu-24.04

Tff7b72stepsTb4b4b4:

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffCheckoutTa5d6ff Ta5d6ffcode

Tff7b72usesTb4b4b4: Ta5d6ffactions/checkout@v6

Tff7b72withTb4b4b4:

Tff7b72fetch-depthTb4b4b4: Ta5d6ff0

Tff7b72submodulesTb4b4b4: Ta5d6ff'Ta5d6ffrecursiveTa5d6ff'

Tff7b72refTb4b4b4: Ta5d6ff${{Ta5d6ff Ta5d6ffinputs.refTa5d6ff Ta5d6ff||Ta5d6ff Ta5d6ff''Ta5d6ff Ta5d6ff}}

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffGradleTa5d6ff Ta5d6ffSetup

Tff7b72usesTb4b4b4: Ta5d6ff./.github/actions/gradle-setup

Tff7b72withTb4b4b4:

Tff7b72gradle_encryption_keyTb4b4b4: Ta5d6ff${{Ta5d6ff Ta5d6ffsecrets.GRADLE_ENCRYPTION_KEYTa5d6ff Ta5d6ff}}

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffBuildTa5d6ff Ta5d6ffDokkaTa5d6ff Ta5d6ffHTMLTa5d6ff Ta5d6ffdocumentation

Tff7b72runTb4b4b4: Ta5d6ff./gradlewTa5d6ff Ta5d6ffdokkaGeneratePublicationHtml

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffUploadTa5d6ff Ta5d6ffartifact

Tff7b72usesTb4b4b4: Ta5d6ffactions/upload-pages-artifact@v5

Tff7b72withTb4b4b4:

Tff7b72pathTb4b4b4: Ta5d6ffbuild/dokka/html

Tff7b72deployTb4b4b4:

Tff7b72ifTb4b4b4: Ta5d6ffgithub.repositoryTa5d6ff Ta5d6ff==Ta5d6ff Ta5d6ff'meshtastic/Meshtastic-Android'

Tff7b72environmentTb4b4b4:

Tff7b72nameTb4b4b4: Ta5d6ffgithub-pages

Tff7b72urlTb4b4b4: Ta5d6ff${{Ta5d6ff Ta5d6ffsteps.deployment.outputs.page_urlTa5d6ff Ta5d6ff}}

Tff7b72runs-onTb4b4b4: Ta5d6ffubuntu-24.04-arm

Tff7b72needsTb4b4b4: Ta5d6ffbuild-docs

Tff7b72stepsTb4b4b4:

Tb4b4b4- Tff7b72nameTb4b4b4: Ta5d6ffDeployTa5d6ff Ta5d6fftoTa5d6ff Ta5d6ffGitHubTa5d6ff Ta5d6ffPages

Tff7b72idTb4b4b4: Ta5d6ffdeployment

Tff7b72usesTb4b4b4: Ta5d6ffactions/deploy-pages@v5